Skip to content

Migrate all ReST files to MyST Markdown format - #170

Merged
Esteban82 merged 4 commits into
masterfrom
copilot/migrate-rest-files-to-markdown
Aug 27, 2026
Merged

Migrate all ReST files to MyST Markdown format#170
Esteban82 merged 4 commits into
masterfrom
copilot/migrate-rest-files-to-markdown

Conversation

Copilot AI commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

ReST syntax is more complex to author and maintain than Markdown. This migrates all 9 .rst source files to MyST Markdown (.md), which supports the same Sphinx directives via a cleaner syntax.

Changes

  • requirements.txt / environment.yml — add myst-parser
  • conf.py — register myst_parser extension, enable colon_fence, update source_suffix to accept both .rst and .md
  • 9 RST → MD conversions:
    • Raw HTML blocks: .. raw:: html```{raw} html
    • Toctree: .. toctree:::::{toctree} (colon-fence syntax)
    • Cross-references: :ref:\text `{ref}`text ``
    • Label targets: .. _label:(label)=
    • RST grid/list tables → GFM tables or :::{list-table} directives
    • Hyperlinks: `text <url>`__[text](url)
    • Inline code: ``code```code`
    • Zenodo badge table (cite page): RST grid table with nested image directives → GFM table with [![]()]() syntax
  • All .rst files deleted

Copilot AI linked an issue Aug 26, 2026 that may be closed by this pull request
Co-authored-by: seisman <3974108+seisman@users.noreply.github.com>
Copilot AI changed the title [WIP] Migrate all ReST files to Markdown formats Migrate all ReST files to MyST Markdown format Aug 26, 2026
Copilot AI requested a review from seisman August 26, 2026 14:46
Copilot AI and others added 2 commits August 27, 2026 06:13
…t-table

Co-authored-by: seisman <3974108+seisman@users.noreply.github.com>
Co-authored-by: seisman <3974108+seisman@users.noreply.github.com>
@seisman
seisman marked this pull request as ready for review August 27, 2026 06:19
@seisman

seisman commented Aug 27, 2026

Copy link
Copy Markdown
Member

I've built the site locally and it looks good.

@seisman
seisman requested a review from Esteban82 August 27, 2026 14:48

@Esteban82 Esteban82 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works fine for me too.

@Esteban82
Esteban82 merged commit e3f4d3e into master Aug 27, 2026
2 checks passed
@Esteban82
Esteban82 deleted the copilot/migrate-rest-files-to-markdown branch August 27, 2026 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Migrate all ReST files to Markdown formats

3 participants